Zync SDK/zync.api.attachments.models

Package-level declarations

Types

Link copied to clipboard
sealed class AttachmentBulkUpdateModuleResult

Result type for bulk updating attachment module and module_uid.

Link copied to clipboard
sealed class AttachmentChangeEvent

Sealed class representing different types of attachment change events that can be received via real-time messaging and delta sync.

Link copied to clipboard
sealed class AttachmentError : Exception

Sealed class representing different types of attachment errors.

Link copied to clipboard
sealed class AttachmentGetResult

Result type for getting a single attachment.

Link copied to clipboard
sealed class AttachmentGroupResult

Result type for attachment operations that return grouped data. Provides clients control over loading states for date-grouped attachments.

Link copied to clipboard
sealed class AttachmentOperationResult

Result type for attachment operations that modify or create attachments.

Link copied to clipboard
sealed class AttachmentResult

Result type for attachment operations that gives clients control over loading states.

Link copied to clipboard
sealed class GetPhotoFeedGroupedResult

Result type for photo feed grouped by date.

Link copied to clipboard
sealed class GetPhotoFeedResult

Result type for photo feed operations with cursor-based pagination.

Link copied to clipboard
sealed class PhotoFeedChangeEvent

Events emitted during photo feed observation. Clients can observe these events to reactively update their UI.

Link copied to clipboard
sealed class UploadAttachmentResult

Result of an immediate upload operation for a single file.

Link copied to clipboard
sealed class UploadAttachmentsResult

Result of an immediate upload operation for multiple files.

Link copied to clipboard
data class UploadedAttachmentData(val attachmentUid: String, val filePath: String, val url: String, val fileSize: Long)

Data for a successfully uploaded attachment.

Link copied to clipboard
data class ZyncAttachment(val attachmentUid: String, val attachmentSize: Long, val attachmentUri: String, val attachmentUriLocal: String?, val attachmentName: String?, val attachmentDescription: String?, val type: ZyncAttachmentType?, val module: ZuperModule?, val moduleUid: String?, val fileHash: String?, val createdBy: String?, val createdByUser: ZyncCreatedByUser?, val mimeType: String?, val thumbnailUrl: String?, val createdAt: String, val updatedAt: String, val isDeleted: Boolean, val tags: List<ZyncTag>, val uploadStatus: ZyncUploadStatus?, val isEditable: Boolean, val latitude: Double?, val longitude: Double?) : Keyed<String>
Link copied to clipboard
data class ZyncAttachmentFilters(val startDate: String? = null, val endDate: String? = null, val mediaType: ZyncAttachmentMediaType = ZyncAttachmentMediaType.ALL, val tags: List<String>? = null)

Data class containing optional filter parameters for attachment queries. All parameters are optional - null values mean no filtering is applied for that parameter.

Link copied to clipboard
data class ZyncAttachmentGroupByDate(val groupLabel: String, val date: String, val attachments: List<ZyncAttachment>)

Represents a group of attachments organized by date.

Link copied to clipboard
enum ZyncAttachmentMediaType : Enum<ZyncAttachmentMediaType>

Enum class representing media types for filtering attachments. Used to filter attachments by their MIME type categories.

Link copied to clipboard
enum ZyncAttachmentType : Enum<ZyncAttachmentType>

Enum class representing the different types of attachments that can be uploaded. Each type has a corresponding constant string value that is used for identifying the attachment type in the system.

Link copied to clipboard
data class ZyncFile(val filePath: String, val latitude: Double?, val longitude: Double?)
Link copied to clipboard
data class ZyncModuleAssociation(val module: ZuperModule, val moduleUid: String)

Represents a module association for attachments. Used to associate attachments with multiple modules.

Link copied to clipboard
data class ZyncPhotoFeedFilters(val startDate: String? = null, val endDate: String? = null, val mediaType: ZyncAttachmentMediaType = ZyncAttachmentMediaType.ALL, val tags: List<String>? = null, val createdBy: List<String>? = null, val showOnlyGlassAttachments: Boolean = false)

Filter parameters for photo feed queries. All parameters are optional - null values mean no filtering is applied.